Scenario #1020: Add Representative to Partner

UseCase Add Representative To Partner => Representative: Tracy Trust for Test AG

Properties

Required

Given

name value
partnerPersonTradeName Test AG
representativeFamilyName Trust
representativeGivenName Tracy
representativePostalAddress         “name”: “Michelle Matthieu”,
        “street”: “An der Alster 100”,
        “zipcode”: “20000”,
        “city”: “Hamburg”,
        “country”: “Germany”
representativePhoneNumber +49 40 123456
representativeEMailAddress tracy.trust@example.org

Person: Test AG

HTTP GET "/api/hs/office/persons?name=Test+AG" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }`
=> status: 200 OK 
[ {
  "uuid" : "9e12338f-c1ea-4237-9d64-f085a84850c6", // Person: Test AG
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Test AG",
  "salutation" : null,
  "title" : null,
  "givenName" : null,
  "familyName" : null
} ]

In production, data this query could result in multiple outputs. In that case, you have to find out which is the right one.

Person: Tracy Trust

HTTP POST "/api/hs/office/persons" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }` \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Trust",
  "givenName" : "Tracy"
}
EOF
=> status: 201 CREATED 9e8b3653-0252-423d-bf1e-b579e1e80702

Please check first if that person already exists, if so, use it’s UUID below.

HINT: A representative is always a natural person and represents a non-natural-person.

Contact: Tracy Trust

HTTP POST "/api/hs/office/contacts" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }` \
  <<EOF
{
  "caption" : "Tracy Trust",
  "postalAddress" : {
    "name" : "Michelle Matthieu",
    "street" : "An der Alster 100",
    "zipcode" : "20000",
    "city" : "Hamburg",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "main" : "+49 40 123456"
  },
  "emailAddresses" : {
    "main" : "tracy.trust@example.org"
  }
}
EOF
=> status: 201 CREATED 3fcf3046-2fe0-4e47-a04e-a960da3836ad

Please check first if that contact already exists, if so, use it’s UUID below.

Create Representative: Tracy Trust for Test AG

HTTP POST "/api/hs/office/relations" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }` \
  <<EOF
{
  "type" : "REPRESENTATIVE",
  "anchor.uuid" : "9e12338f-c1ea-4237-9d64-f085a84850c6", // Person: Test AG
  "holder.uuid" : "9e8b3653-0252-423d-bf1e-b579e1e80702", // Person: Tracy Trust
  "contact.uuid" : "3fcf3046-2fe0-4e47-a04e-a960da3836ad" // Contact: Tracy Trust
}
EOF
=> status: 201 CREATED 75be97e0-2625-46cd-883a-b4a6b0c63be3

Verify the REPRESENTATIVE Relation Got Removed

HTTP GET "/api/hs/office/relations?relationType=REPRESENTATIVE&personData=Trust" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }`
=> status: 200 OK 
[ {
  "uuid" : "75be97e0-2625-46cd-883a-b4a6b0c63be3",
  "anchor" : {
    "uuid" : "9e12338f-c1ea-4237-9d64-f085a84850c6", // Person: Test AG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Test AG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "9e8b3653-0252-423d-bf1e-b579e1e80702", // Person: Tracy Trust
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Tracy",
    "familyName" : "Trust"
  },
  "type" : "REPRESENTATIVE",
  "mark" : null,
  "contact" : {
    "uuid" : "3fcf3046-2fe0-4e47-a04e-a960da3836ad", // Contact: Tracy Trust
    "caption" : "Tracy Trust",
    "postalAddress" : {
      "zipcode" : "20000",
      "country" : "Germany",
      "city" : "Hamburg",
      "street" : "An der Alster 100",
      "name" : "Michelle Matthieu"
    },
    "emailAddresses" : {
      "main" : "tracy.trust@example.org"
    },
    "phoneNumbers" : {
      "main" : "+49 40 123456"
    }
  }
} ]

generated on 2026-08-10 04:34:19 for branch HEAD